/*
 * Copyright 2009 (c) Patrick Pietens.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package
{
	import indigo.model.ApplicationModel;

	/**
	 * The <code>setProperty</code> function is used as a shortcut to set the 
	 * state of your Indigo application.
	 * 
	 * <p>In most cases, such as when the value of a property is a primitive 
	 * type like a <code>String</code> or <code>Number</code>, you can call 
	 * <code>setProperty()</code> shortcut. However, when the value of a 
	 * property is an object that contains its own properties like an Array or 
	 * Dictionary, set the isDirty parameter to true. Otherwise the 
	 * <code>ModelLocator</code> won't see its change causing 
	 * <code>Views</code> not to update.</p>
	 *  
	 * @example
	 * <listing version="3.0">
	 * </listing>
	 *  
	 * @param String that indicates the name of the property
	 * @param Value of the property
	 * @param Indicates that the value of the property has changed. Use the 
	 * option when setting objects that contains own properties
	 * 
	 * @playerversion Flash 9
	 * @langversion ActionScript 3.0
	 * 
	 * @deprecated
	 * @see	ModelLocator
	 */
	public function setProperty( name:String, value:*, isDirty:Boolean = false ):void
	{
		var myModel:ApplicationModel = ApplicationModel.getInstance();
		if ( value != null && value != undefined )
			myModel[ name ] = value;
		else
			delete myModel[ name ];

		if ( isDirty )
			myModel.setDirty( name );
	}
}
